openapi: 3.0.1
info:
title: IDP Runtime Service API
version: v1
servers:
- url: https://{region}.anypoint.mulesoft.com
description: IDP Runtime Service endpoints
variables:
anypointEnvironment:
description: replace the {anypointEnvironment} under Access token URI before clicking 'Refresh access token' button to get the bearer token for the current environment.
default: anypoint.mulesoft.com
enum:
- anypoint.mulesoft.com
- eu1.anypoint.mulesoft.com
region:
description: Select the region for the IDP Runtime Service.
default: idp-rt.us-east-1
enum:
- idp-rt.us-east-1
- idp-rt.eu-central-1
paths:
/api/v1/organizations/{organizationId}/actions/{actionId}/reviews/{executionId}:
delete:
operationId: deleteLowConfidenceFields
parameters:
- description: Action Id
in: path
name: actionId
required: true
schema:
type: string
- description: Execution Id
in: path
name: executionId
required: true
schema:
type: string
format: uuid
- description: Organization ID
in: path
name: organizationId
required: true
schema:
type: string
responses:
'200':
description: Success
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Internal Server Error
security:
- mulesoft-basic-login: []
summary: Delete a review task (Execution Status is updated as SUCCEEDED without changing the execution result)
tags:
- delete a review task
get:
operationId: getLowConfidenceFields
parameters:
- description: Action Id
in: path
name: actionId
required: true
schema:
type: string
- description: Execution Id
in: path
name: executionId
required: true
schema:
type: string
format: uuid
- description: Organization ID
in: path
name: organizationId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentActionLowConfidenceExecution'
description: Success
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Internal Server Error
security:
- mulesoft-basic-login: []
summary: Get a list of low-confidence fields by Execution Id
tags:
- low-confidence fields
patch:
operationId: patchLowConfidenceFields
parameters:
- description: Action Id
in: path
name: actionId
required: true
schema:
type: string
- description: Execution Id
in: path
name: executionId
required: true
schema:
type: string
format: uuid
- description: Organization ID
in: path
name: organizationId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentActionLowConfidenceExecution'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentActionLowConfidenceExecution'
description: Success
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Bad Request
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Internal Server Error
security:
- mulesoft-basic-login: []
summary: 'Patch a list of low-confidence fields by Execution Id '
tags:
- patch low-confidence fields
/api/v1/organizations/{organizationId}/actions/{actionId}/versions/{version}/executions:
post:
operationId: executeVersionedAction_1
parameters:
- description: orgId
in: path
name: organizationId
required: true
schema:
type: string
- description: Action ID
in: path
name: actionId
required: true
schema:
type: string
- description: Version of the Action
in: path
name: version
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Base64ActionExecutionRequest'
multipart/form-data:
schema:
type: object
properties:
callback:
type: string
description: Callback URL
example:
noAuthUrl: callbackURL
default: '{"noAuthUrl":"callbackURL"}'
file:
$ref: '#/components/schemas/Part'
required:
- file
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/postExecutionResponse'
description: Created
'400':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Bad Request
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Internal Server Error
security:
- bearerAuth: []
summary: Execute a versioned Action with a File or Base64 payload
tags:
- actionExecution
/api/v1/organizations/{organizationId}/actions/{actionId}/versions/{version}/executions/{executionId}:
get:
operationId: getVersionedActionExecution
parameters:
- description: orgId
in: path
name: organizationId
required: true
schema:
type: string
- description: Action ID
in: path
name: actionId
required: true
schema:
type: string
- description: Version
in: path
name: version
required: true
schema:
type: string
- description: Id of the ActionExecution
in: path
name: executionId
required: true
schema:
type: string
format: uuid
- description: Only keep the extracted value of the given field, remove confidenceScore and geometry from the response body
in: query
name: valueOnly
required: false
schema:
type: boolean
default: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/JsonNode'
description: Success
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Internal Server Error
security:
- bearerAuth: []
summary: Get an execution of a published action by a given action Id and action version
tags:
- action-versioned-execution
/api/v1/organizations/{organizationId}/reviews:
get:
operationId: getExecutionsToReview
parameters:
- description: organizationId
in: path
name: organizationId
required: true
schema:
type: string
- in: query
name: pageable
required: true
schema:
$ref: '#/components/schemas/Pageable'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ReviewItem'
description: Success
'500':
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
description: Internal Server Error
security:
- mulesoft-basic-login: []
summary: Get a list of all executions requiring manual review, across actions, that the requesting user has permission to review
tags:
- pending-review-operations
components:
schemas:
Base64ActionExecutionRequest:
required:
- file
type: object
properties:
callback:
type: string
description: Callback Url
example: '{"noAuthUrl":"callbackURL"}'
file:
type: string
description: File content in base64 string format
example: JVBERi0xLjMKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291cm5lcyAyIDAgUgovQ29udGVudHMgNCAwIFI+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNzE+PgpzdHJlYW0KeJwzUvDiMtAzNVco53IKUdB3M1Sw0DMwUAhJU3ANAYkYG+oZWihYGJjoGZgphKQoaBQn5qQWp+UXJadqKoRkgVQBAO5BEAMKZW5kc3RyZWFtCmVuZG9iagoxIDAgb2JqCjw8L1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUiBdCi9Db3VudCAxCi9NZWRpYUJveCBbMCAwIDU5NS4yOCA4NDEuODldCj4+CmVuZG9iago1IDAgb2JqCjw8L1R5cGUgL0ZvbnQKL0Jhc2VGb250IC9IZWx2ZXRpY2EKL1N1YnR5cGUgL1R5cGUxCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iagoyIDAgb2JqCjw8Ci9Qcm9jU2V0IFsvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJXQovRm9udCA8PAovRjEgNSAwIFIKPj4KL1hPYmplY3QgPDwKPj4KPj4KZW5kb2JqCjYgMCBvYmoKPDwKL1Byb2R1Y2VyIChQeUZQREYgMS43LjIgaHR0cDovL3B5ZnBkZi5nb29nbGVjb2RlLmNvbS8pCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNTAxMDgwNDU4MzgpCj4+CmVuZG9iago3IDAgb2JqCjw8Ci9UeXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgovT3BlbkFjdGlvbiBbMyAwIFIgL0ZpdEggbnVsbF0KL1BhZ2VMYXlvdXQgL09uZUNvbHVtbgo+PgplbmRvYmoKeHJlZgowIDgKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMjI3IDAwMDAwIG4gCjAwMDAwMDA0MTAgMDAwMDAgbiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDg3IDAwMDAwIG4gCjAwMDAwMDAzMTQgMDAwMDAgbiAKMDAwMDAwMDUxNCAwMDAwMCBuIAowMDAwMDAwNjIzIDAwMDAwIG4gCnRyYWlsZXIKPDwKL1NpemUgOAovUm9vdCA3IDAgUgovSW5mbyA2IDAgUgo+PgpzdGFydHhyZWYKNzI2CiUlRU9GCg==
fileName:
type: string
description: File name provided by user
example: testFile.pdf
description: Request object for executing an action with a Base64-encoded file
DocumentActionLowConfidenceExecution:
required:
- analyzersResults
- queriesResults
- results
- signaturesResults
type: object
properties:
analyzersResults:
type: array
description: Analyzers that need review
items:
$ref: '#/components/schemas/FilteredLlmAnalyzerLowConfidenceResult'
default: []
queriesResults:
$ref: '#/components/schemas/Json'
results:
$ref: '#/components/schemas/Json'
signaturesResults:
$ref: '#/components/schemas/Json'
description: Low Confidence Items/Queries/Analyzers/Signatures
example:
results: []
queriesResults: []
analyzersResults: []
signaturesResults: []
FilteredLlmAnalyzerLowConfidenceResult:
required:
- confidenceScore
- id
- name
- query
- result
type: object
properties:
confidenceScore:
type: number
format: float
id:
type: string
format: uuid
isValidated:
type: boolean
name:
type: string
query:
type: string
result:
type: string
description: Analyzers that need review
default: []
Json:
type: object
description: Signatures with Low Confidence Scores
default: []
JsonNode:
type: object
Pageable:
type: object
properties:
page:
minimum: 0
type: integer
format: int32
size:
minimum: 1
type: integer
format: int32
sort:
type: array
items:
type: string
Part:
type: object
Problem:
type: object
properties:
detail:
type: string
description: Human-readable explanation specific to this occurrence of the problem
status:
type: integer
description: Number indicating the HTTP status code generated by the origin server for this occurrence of the problem
format: int32
title:
type: string
description: Short, human-readable summary of the problem type
type:
type: string
description: URI reference that identifies the problem type
format: uri
description: Problem details response object
ReviewItem:
type: object
properties:
docActionId:
type: string
description: Document Action Id
docFileId:
type: string
description: Document File Id
format: uuid
docFileName:
type: string
description: Document FileName
docOperationCreationDate:
type: string
description: Document Operation Creation Date
format: date-time
docOperationId:
type: string
description: Document Operation Id
format: uuid
description: Review Item Response
postExecutionResponse:
type: object
properties:
documentName:
type: string
id:
type: string
status:
type: string
description: Response to POST execution
securitySchemes:
bearerAuth:
flows:
clientCredentials:
scopes: {}
tokenUrl: https://{anypointEnvironment}/accounts/api/v2/oauth2/token
type: oauth2
mulesoft-basic-login:
description: Used to send username and password. Do not use with the "access_token" query string parameter.
scheme: basic
type: http